Hybris Sales UX API
SSNSearch - NonTMF POST
Usecase is to lookup for the customer at salesforce based on encrypted SSN to identify if the customer is existing or new.
URL
https://[localhost]:[port]/ecom-sales-ux/v1/{businessId}/SSNSearch
Base Uri Param
name | type | description | required |
---|---|---|---|
businessId | string | Business unit identifier. Example: JM,PA,PR,CR | Y |
Header
name | value | description | required |
---|---|---|---|
client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
cURL request
curl --location 'https://nonprod.esb.cloud.lla.com/test/ecom-sales-ux/ecom-sales-ux/v1/PR/SSNSearch' \
--header 'client_id: 7afe7ffbe27147bcb5308c92fd3d9488' \
--header 'client_secret: 875c5df1fC294C6Db584a670d0408019' \
--header 'X-Correlation-ID: 5478-asdf5454-sad545-sear545dsf-54e5d4g' \
--header 'Content-Type: application/json' \
--data '{
"RequestType": "EncryptedSSNLookup",
"SourceSystem": "APP",
"EncryptedSSN": "mreNSefeKAc10cG4aBt5d+Cxs="
}'
Definitions
Each of the request parameters is detailed.
name | type | description | required |
---|---|---|---|
RequestType | string | type of the request allowed values are "EncryptedSSNLookup" | Y |
SourceSystem | string | name of source system allowed values are "APP" | Y |
EncryptedSSN | string | encrypted SSN. Advanced Encryption Standard (AES256) with cipher block chaining (CBC) PKCS5 padding | Y |
Response
Success Response with 200
{
"status": 200,
"message": "SSN already exists.",
"BANCAN": "23636033-23637361"
}
Definitions
Each of the request parameters is detailed.
name | type | description | required |
---|---|---|---|
status | number | http status code | N |
message | string | status message | N |
BANCAN | string | Billing account number - customer account number | N |